home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1993 July / InfoMagic USENET CD-ROM July 1993.ISO / sources / unix / volume26 / arc-5.21 / part03 < prev    next >
Encoding:
Text File  |  1992-04-10  |  55.7 KB  |  2,149 lines

  1. Newsgroups: comp.sources.unix
  2. From: hyc@umix.cc.umich.edu (Howard Chu)
  3. Subject: v26i006: arc 5.21 (pl 8) - file archive/compression tool, Part03/03
  4. Sender: unix-sources-moderator@pa.dec.com
  5. Approved: vixie@pa.dec.com
  6.  
  7. Submitted-By: hyc@umix.cc.umich.edu (Howard Chu)
  8. Posting-Number: Volume 26, Issue 6
  9. Archive-Name: arc-5.21/part03
  10.  
  11. #! /bin/sh
  12. # This is a shell archive.  Remove anything before this line, then unpack
  13. # it by saving it into a file and typing "sh file".  To overwrite existing
  14. # files, type "sh file -c".  You can also feed this as standard input via
  15. # unshar, or by typing "sh <file", e.g..  If this archive is complete, you
  16. # will see the following message at the end:
  17. #        "End of archive 3 (of 3)."
  18. # Contents:  Arc521.doc
  19. # Wrapped by vixie@cognition.pa.dec.com on Sat Apr 11 13:54:35 1992
  20. PATH=/bin:/usr/bin:/usr/ucb ; export PATH
  21. if test -f 'Arc521.doc' -a "${1}" != "-c" ; then 
  22.   echo shar: Will not clobber existing file \"'Arc521.doc'\"
  23. else
  24. echo shar: Extracting \"'Arc521.doc'\" \(54118 characters\)
  25. sed "s/^X//" >'Arc521.doc' <<'END_OF_FILE'
  26. X
  27. X
  28. X
  29. X
  30. X
  31. X
  32. X
  33. X
  34. X
  35. X
  36. X
  37. X
  38. X                          ARC
  39. X
  40. X                 File Archive Utility
  41. X                     Version 5.20
  42. X
  43. X
  44. X
  45. X
  46. X
  47. X
  48. X
  49. X
  50. X
  51. X
  52. X
  53. X
  54. X
  55. X
  56. X
  57. X
  58. X
  59. X
  60. X
  61. X
  62. X
  63. X
  64. X
  65. X
  66. X
  67. X                 (C)COPYRIGHT 1985,86
  68. X                          by
  69. X          System Enhancement Associates, Inc.
  70. X                  ALL RIGHTS RESERVED
  71. X
  72. X
  73. X
  74. X
  75. X
  76. This document describes version 5.20 of the ARC file
  77. utility, which was created by System Enhancement
  78. Associates, Inc. in October of 1986.
  79. X
  80. X
  81. X        TABLE OF CONTENTS
  82. X
  83. X
  84. X
  85. Section                                           Page
  86. X
  87. X
  88. Introduction  ....................................   1
  89. Using ARC  .......................................   3
  90. ARC commands  ....................................   5
  91. X    Adding files  ................................   5
  92. X    Extracting files  ............................   7
  93. X    Deleting files  ..............................   8
  94. X    Listing archive entries  .....................   8
  95. X    Running files  ...............................  10
  96. X    Printing files  ..............................  11
  97. X    Testing an archive  ..........................  11
  98. X    Converting an archive  .......................  12
  99. ARC options  .....................................  13
  100. X    Suppressing compression  .....................  13
  101. X    Backup retention  ............................  14
  102. X    Message suppression  .........................  15
  103. X    Encryption/Decryption  .......................  17
  104. RAMdisk support  .................................  18
  105. MARC  ............................................  19
  106. ARCE  ............................................  20
  107. Version numbers  .................................  21
  108. Common questions and answers  ....................  22
  109. Maintenance contracts  ...........................  24
  110. Revision history  ................................  25
  111. X    Changes in version 3  ........................  25
  112. X    Changes in version 4  ........................  25
  113. X    Changes in version 4.1  ......................  26
  114. X    Changes in version 4.3  ......................  26
  115. X    Changes in version 4.4  ......................  27
  116. X    Changes in version 4.5  ......................  27
  117. X    Changes in version 5.0  ......................  28
  118. X    Changes in version 5.1  ......................  29
  119. X    Changes in version 5.2  ......................  30
  120. Program history and credits  .....................  31
  121. Bulletin boards  .................................  33
  122. Site licenses  ...................................  34
  123. X
  124. X
  125. X
  126. X
  127. X
  128. X
  129. X
  130. X
  131. X
  132. X
  133. X
  134. X
  135. X
  136. X          INTRODUCTION
  137. X
  138. X
  139. X
  140. ARC is the copyrighted property of System Enhancement
  141. Associates, Inc.  You are granted a limited license to
  142. use ARC, and to copy it and distribute it, provided
  143. that the following conditions are met:
  144. X
  145. X1) No fee may be charged for such copying and
  146. X   distribution.
  147. X
  148. X2) ARC may ONLY be distributed in its original,
  149. X   unmodified state.
  150. X
  151. X3) ARC may *not* be distributed, in whole or in part, as
  152. X   part of any commercial product or service without
  153. X   the express written permission of System
  154. X   Enhancement Associates.
  155. X
  156. X
  157. Contributions for the use of this program will be
  158. appreciated, and should be sent to:
  159. X
  160. X          System Enhancement Associates, Inc.
  161. X             21 New Street, Wayne NJ 07470
  162. X
  163. You may not use this product in a commercial
  164. environment or a governmental organization without
  165. paying a license fee of $35.  Site licenses and
  166. commercial distribution licenses are available.  A
  167. program disk and printed documentation are available
  168. for $50.  See the order form enclosed with this manual
  169. for more details.
  170. X
  171. X
  172. X
  173. ARC is user supported software.  This means that you
  174. may copy it freely and give the copies away to anyone
  175. you wish, at no cost.  They are in turn requested to
  176. send in a contribution if they decide to use it.
  177. X
  178. The user supported software concept (often referred to
  179. as "shareware") is an attempt to provide software at low
  180. cost.  The cost of offering a new product by
  181. conventional means is staggering, and hence dissuades
  182. many independent authors and small companies from
  183. developing and promoting their ideas.  User supported
  184. software is an attempt to develop a new marketing
  185. channel, where products can be introduced at low cost.
  186. X
  187. X
  188. X
  189. X
  190. ARC                                              Page 1
  191. X If user supported software works, then everyone will
  192. benefit.  The user will benefit by receiving quality
  193. products at low cost, and by being able to "test
  194. drive" software thoroughly before purchasing it.  The
  195. author benefits by being able to enter the commercial
  196. software arena without first needing large sources of
  197. venture capital.
  198. X
  199. But it can only work with your support.  We're not
  200. just talking about ARC here, but about all user
  201. supported software.  If you obtain a user supported
  202. program from a friend or colleague, and are still
  203. using it after a couple of weeks, then it is obviously
  204. worth something to you, and a contribution should be
  205. sent.
  206. X
  207. X
  208. X
  209. And now, back to ARC:
  210. X
  211. ARC is used to create and maintain file archives.  An
  212. archive is a group of files collected together into
  213. one file in such a way that the individual files may
  214. be recovered intact.
  215. X
  216. ARC is different from other archive and library
  217. utilities in that it automatically compresses the
  218. files being archived, so that the resulting archive
  219. takes up a minimum amount of space.
  220. X
  221. When ARC is used to add a file to an archive it
  222. analyzes the file to determine which of three storage
  223. methods will result in the greatest savings.  These
  224. three methods are:
  225. X
  226. X1) No compression; the file is stored as is.
  227. X
  228. X2) Repeated-character compression; repeated sequences
  229. X   of the same byte value are collapsed into a three-
  230. X   byte code sequence.
  231. X
  232. X3) Dynamic Lempel-Zev compression;  the file is stored
  233. X   as a series of variable size bit codes which
  234. X   represent character strings, and which are created
  235. X   "on the fly".
  236. X
  237. Note that since one of the three methods involves no
  238. compression at all, the resulting archive entry will
  239. never be larger than the original file.
  240. X
  241. X
  242. X
  243. X
  244. X
  245. ARC                                              Page 2
  246. X            USING ARC
  247. X
  248. X
  249. X
  250. ARC is invoked with a command of the following format:
  251. X
  252. X    ARC <x> <arcname> [<template> . . .]
  253. X
  254. Where:
  255. X
  256. X    <x> is an ARC command letter (see below), in
  257. X    either upper or lower case.
  258. X
  259. X    <arcname> is the name of the archive to act on,
  260. X    with or without an extension.  If no extension is
  261. X    supplied, then ".ARC" is assumed.  The archive
  262. X    name may include path and drive specifiers.
  263. X
  264. X    <template> is one or more file name templates.
  265. X    The "wildcard" characters "*" and "?" may be used.
  266. X    A file name template may include a path or drive
  267. X    specifier, though it isn't always meaningful.
  268. X
  269. X
  270. If ARC is invoked with no arguments (by typing "ARC",
  271. and pressing "enter"), then a brief command summary is
  272. displayed.
  273. X
  274. X
  275. X
  276. XFollowing is a brief summary of the available ARC
  277. commands:
  278. X
  279. X    a   = add files to archive
  280. X    m   = move files to archive
  281. X    u   = update files in archive
  282. X    f   = freshen files in archive
  283. X    d   = delete files from archive
  284. X    x,e = extract files from archive
  285. X    r   = run files from archive
  286. X    p   = copy files from archive to standard output
  287. X    l   = list files in archive
  288. X    v   = verbose listing of files in archive
  289. X    t   = test archive integrity
  290. X    c   = convert entry to new packing method
  291. X
  292. X
  293. X
  294. X
  295. X
  296. X
  297. X
  298. X
  299. X
  300. ARC                                              Page 3
  301. X Following is a brief summary of the available ARC
  302. options, which may alter how a command works:
  303. X
  304. X    b   = retain backup copy of archive
  305. X    s   = suppress compression (store only)
  306. X    w   = suppress warning messages
  307. X    n   = suppress notes and comments
  308. X    o   = overwrite existing files when extracting
  309. X    g   = encode or decode archive entry
  310. X
  311. X
  312. X
  313. X
  314. X
  315. X
  316. X
  317. X
  318. X
  319. X
  320. X
  321. X
  322. X
  323. X
  324. X
  325. X
  326. X
  327. X
  328. X
  329. X
  330. X
  331. X
  332. X
  333. X
  334. X
  335. X
  336. X
  337. X
  338. X
  339. X
  340. X
  341. X
  342. X
  343. X
  344. X
  345. X
  346. X
  347. X
  348. X
  349. X
  350. X
  351. X
  352. X
  353. X
  354. X
  355. ARC                                              Page 4
  356. X          ARC COMMANDS
  357. X
  358. X
  359. X
  360. This section describes each of the commands.  ARC will
  361. accept any one command at a time.  If no commands are
  362. given, then a brief command list is displayed.
  363. X
  364. X
  365. X
  366. ADDING FILES
  367. X
  368. XFiles are added to an archive using the "A" (Add), "M"
  369. X(Move), "U" (Update), or "F" (Freshen) commands.  Add
  370. always adds the file.  Move differs from Add in that
  371. the source file is deleted once it has been added to
  372. the archive.
  373. X
  374. Update differs from Add in that the file is only added
  375. if it is not already in the archive, or if it is newer
  376. that the corresponding entry in the archive.
  377. X
  378. XFreshen is similar to Update, except that new files
  379. are not added to the archive; only files already in
  380. the archive are updated.
  381. X
  382. X
  383. XFor example, if you wish to add a file named
  384. X"TEST.DAT" to an archive named "MY.ARC", you would use
  385. a command of the form:
  386. X
  387. X    ARC a my test.dat
  388. X
  389. If you wanted to add all files with a ".C" extension,
  390. and all files named "STUFF" to an archive named
  391. X"JUNK.ARC", you could type:
  392. X
  393. X    ARC a junk *.c stuff.*
  394. X
  395. If you wanted to move all files in your current
  396. directory into an archive named "SUM.ARC", you could
  397. use a command of the form:
  398. X
  399. X    ARC m sum *.*
  400. X
  401. If you have an archive named "TEXT.ARC", and you
  402. wanted to add to it all of your files with an
  403. extension of ".TXT" which have been created or changed
  404. since they were last archived, then you would type:
  405. X
  406. X    ARC u text *.txt
  407. X
  408. X
  409. X
  410. ARC                                              Page 5
  411. X If you have a bunch of files in your current
  412. directory, with backup copies being stored in an
  413. archive named "SAFE.ARC", then if you wanted to make
  414. sure that every file in the archive is the latest
  415. version of that file, you would type:
  416. X
  417. X    ARC f safe
  418. X
  419. X
  420. A word about Update and Freshen:  These are similar in
  421. that they look at the date and time of last change on
  422. the file, and only add it if the file has been changed
  423. since it was last archived.  They differ in that
  424. Update will add new files, while Freshen will not.
  425. X
  426. In other words, Update looks for the files on disk,
  427. and adds them if they are new or have changed, while
  428. XFreshen looks in the archive, and tries to update the
  429. files which are already there.
  430. X
  431. X
  432. Archive entries are always maintained in alphabetic
  433. order.  Archive entries may not have duplicate names.
  434. If you add a file to an archive that already contains
  435. a file by that name, then the existing entry in the
  436. archive is replaced.  Also, the archive itself and its
  437. backup will not be added.
  438. X
  439. You may also add a file which is in a directory other
  440. than your current directory.  For example, it is
  441. perfectly legal to type:
  442. X
  443. X    ARC a junk c:\dustbin\stuff.txt
  444. X
  445. You cannot add two files with the same name.  In other
  446. words, if you have a file named "C:\DUSTBIN\STUFF.TXT"
  447. and another file named "C:\BUCKET\STUFF.TXT", then
  448. typing:
  449. X
  450. X    arc a junk c:\dustbin\*.* c:\bucket\*.*
  451. X
  452. will not work.
  453. X
  454. X
  455. ARC does not save the path name.  In other words, if
  456. you specify a drive and/or path when adding a file,
  457. only the actual file name is stored in the archive.
  458. X
  459. X
  460. X
  461. X
  462. X
  463. X
  464. X
  465. ARC                                              Page 6
  466. X ARC will never add an archive to itself, nor will it
  467. add the temporary copy or a backup copy of the
  468. archive.
  469. X
  470. X
  471. An interesting note:  It has been brought to our
  472. attention that BASIC programs compress to a smaller
  473. size when they are *not* tokenized.  If you are more
  474. concerned with space than speed, you may wish to
  475. convert your BASIC programs to ASCII form before
  476. adding them to an archive.  Your BASIC manual should
  477. give instructions on how to do this.
  478. X
  479. X
  480. X
  481. XEXTRACTING FILES
  482. X
  483. Archive entries are extracted with the "E" (Extract)
  484. and "X" (eXtract) commands.  For example, if you had
  485. an archive named "JUNK.ARC", and you wanted all files
  486. in it with an extension of ".TXT" or ".DOC" to be
  487. recreated on your disk, you could type:
  488. X
  489. X    ARC x junk *.txt *.doc
  490. X
  491. If you wanted to extract all of the files in an
  492. archive named "JUNK.ARC", you could simply type:
  493. X
  494. X    ARC x junk
  495. X
  496. Whatever method of file compression was used in
  497. storing the files is reversed, and uncompressed copies
  498. are created in the current directory.
  499. X
  500. You can also specify a path name, in which case the
  501. decompressed copy is placed in the specified
  502. directory.  For example, if you had an archive named
  503. X"JUNK.ARC", and you wanted all files in it with an
  504. extension of ".TXT" to be placed in the directory
  505. X"C:\WASTE\LAND", then you could type:
  506. X
  507. X    ARC x junk c:\waste\land\*.txt
  508. X
  509. If you wanted to put the file "TRASH.TXT" on your A:
  510. drive, and the file "LITTER.TXT" on your B: drive, you
  511. could type:
  512. X
  513. X    ARC x junk a:trash.txt b:litter.txt
  514. X
  515. X
  516. X
  517. X
  518. X
  519. X
  520. ARC                                              Page 7
  521. X If you give more than one path for a file, then only
  522. the first one is used.  For example, if you typed:
  523. X
  524. X    ARC x junk a:trash.txt b:trash.txt
  525. X
  526. then TRASH.TXT will be placed on your A: drive.
  527. X
  528. X
  529. X
  530. DELETING FILES
  531. X
  532. Archive entries are deleted with the "D" (Delete)
  533. command.  For example, if you had an archive named
  534. X"JUNK.ARC", and you wished to delete all entries in it
  535. with a filename extension of ".C", you could type:
  536. X
  537. X    ARC d junk *.c
  538. X
  539. X
  540. X
  541. LISTING ARCHIVE ENTRIES
  542. X
  543. You can obtain a list of the contents of an archive by
  544. using the "L" (List) command or the "V" (Verbose list)
  545. command.  For example, to see what is in an archive
  546. named "JUNK.ARC", you could type:
  547. X
  548. X    ARC l junk
  549. X
  550. If you are only interested in files with an extension
  551. of ".DOC", then you could type:
  552. X
  553. X    ARC l junk *.doc
  554. X
  555. X
  556. ARC prints a short listing of an archive's contents
  557. like this:
  558. X
  559. X    Name          Length    Date
  560. X    ============  ========  =========
  561. X    ALPHA.TXT         6784  16 May 85
  562. X    BRAVO.TXT         2432  16 May 85
  563. X    COCO.TXT           256  16 May 85
  564. X            ====  ========
  565. X    Total      3      9472
  566. X
  567. X
  568. X"Name" is simply the name of the file.
  569. X
  570. X
  571. X
  572. X
  573. X
  574. X
  575. ARC                                              Page 8
  576. X "Length" is the unpacked file length.  In other words,
  577. it is the number of bytes of disk space which the file
  578. would take up if it were extracted.
  579. X
  580. X"Date" is the date on which the file had last been
  581. modified, as of the time when it was added to the
  582. archive.
  583. X
  584. X"Total" is pretty obvious, I think.
  585. X
  586. X
  587. ARC prints a verbose listing of an archive's contents
  588. like this:
  589. X
  590. Name          Length    Stowage    SF   Size now  Date       Time    CRC
  591. X============  ========  ========  ====  ========  =========  ======  ====
  592. ALPHA.TXT         6784  Crunched   35%      4413  16 May 85  11:53a  8708
  593. BRAVO.TXT         2432  Crunched   41%      1438  16 May 85  11:53a  5BD6
  594. COCO.TXT           256   Packed     5%       244  16 May 85  11:53a  3AFB
  595. X        ====  ========            ====  ========
  596. Total      3      9472             27%      6095
  597. X
  598. X
  599. X"Name", "Length", and "Date" are the same as for a
  600. short listing.
  601. X
  602. X"Stowage" is the compression method used.  The
  603. following compression methods are currently known:
  604. X
  605. X       --          No compression.
  606. X
  607. X     Packed        Runs of repeated byte values are
  608. X                   collapsed.
  609. X
  610. X    Crunched       Lempel-Zev compression technique
  611. X                   employed.
  612. X
  613. X    Squeezed       Huffman encoding compression
  614. X                   technique, as employed by an
  615. X                   earlier version of ARC.
  616. X
  617. X"SF" is the stowage factor.  In other words, it is the
  618. percentage of the file length which was saved by
  619. compression.  The total stowage factor is the stowage
  620. factor for the archive as a whole, not counting
  621. archive overhead.
  622. X
  623. X"Size now" is the number of bytes the file is
  624. occupying while in the archive.
  625. X
  626. X
  627. X
  628. X
  629. X
  630. ARC                                              Page 9
  631. X "Time" is the time of last modification, and is
  632. associated with the date of last modification.
  633. X
  634. X"CRC" is the CRC check value which has been stored
  635. with the file.  Another CRC value will be calculated
  636. when the file is extracted or tested to ensure data
  637. integrity.  There is no especially good reason for
  638. displaying this value.
  639. X
  640. X
  641. X
  642. RUNNING FILES
  643. X
  644. Archive entries may be run without being extracted by
  645. use of the "R" (Run) command.  For example, if you had
  646. an archive named "JUNK.ARC" which contained a file
  647. named "LEMON.COM", which you wished to run, you could
  648. type:
  649. X
  650. X    ARC r junk lemon
  651. X
  652. You can run any file from an archive which has an
  653. extension of ".COM", ".EXE", ".BAT", or ".BAS".  You
  654. do not have to specify the extension, but all matching
  655. files are run if you do not.  In other words, if you
  656. had an archive named "JUNK.ARC" which contained the
  657. files "LEMON.COM", "LEMON.EXE", and "LEMON.BAS", and
  658. you typed:
  659. X
  660. X    ARC r junk lemon
  661. X
  662. Then all three programs will be run.  You can avoid
  663. this by specifying an extension in this case.
  664. X
  665. You can give arguments to the program you are running
  666. by appending them to the command line.  For example,
  667. if you have an archive named "JUNK.ARC" which contains
  668. a program named "LEMON.COM", and you wanted to run it
  669. giving it the argument "JUICE", you would type:
  670. X
  671. X    ARC r junk lemon juice
  672. X
  673. You will need a fair amount of memory to run a program
  674. from an archive.  It probably cannot be done with less
  675. than 256k.
  676. X
  677. X
  678. X
  679. X
  680. X
  681. X
  682. X
  683. X
  684. X
  685. ARC                                             Page 10
  686. X In practice, the file to be run is extracted, run, and
  687. then deleted.  In other words, the above example is
  688. equivalent to:
  689. X
  690. X    ARC x junk lemon.com
  691. X    lemon juice
  692. X    erase lemon.com
  693. X
  694. If you have an archive which contains a program that
  695. you will be running often, then you should probably
  696. extract the program from the archive and use it
  697. normally.
  698. X
  699. X
  700. X
  701. PRINTING FILES
  702. X
  703. Archive entries may be examined with the "P" (Print)
  704. command.  This works the same as the Extract command,
  705. except that the files are not created on disk.
  706. Instead, the contents of the files are written to
  707. standard output.  For example, if you wanted to see
  708. the contents of every ".TXT" file in an archive named
  709. X"JUNK.ARC", but didn't want them saved on disk, you
  710. could type:
  711. X
  712. X    ARC p junk *.txt
  713. X
  714. If you wanted them to be printed on your printer
  715. instead of on your screen, you could type:
  716. X
  717. X    ARC p junk *.txt >prn
  718. X
  719. X
  720. X
  721. TESTING AN ARCHIVE
  722. X
  723. The integrity of an archive may be tested by use of
  724. the "T" (Test) command.  This checks to make sure that
  725. all of the file headers are properly placed, and that
  726. all of the files are in good shape.
  727. X
  728. This can be very useful for critical archives, where
  729. data integrity must be assured.  When an archive is
  730. tested, all of the entries in the archive are unpacked
  731. X(without saving them anywhere) so that a CRC check
  732. value may be calculated and compared with the recorded
  733. CRC value.
  734. X
  735. X
  736. X
  737. X
  738. X
  739. X
  740. ARC                                             Page 11
  741. X For example, if you just received an archive named
  742. X"JUNK.ARC" over a phone line, and you want to make
  743. sure that you received it properly, you could type:
  744. X
  745. X    ARC t junk
  746. X
  747. It defeats the purpose of the T command to combine it
  748. with N or W.
  749. X
  750. X
  751. X
  752. CONVERTING AN ARCHIVE
  753. X
  754. The "C" (Convert) command is used to convert an
  755. archive entry to take advantage of newer compression
  756. techniques.  This is occasionally desirable when a new
  757. version of ARC is released.  Please refer to the
  758. revision history section for details on when new
  759. compression methods were implemented.
  760. X
  761. XFor example, if you had an archive named "JUNK.ARC",
  762. and you wanted to make sure that all files with an
  763. extension of ".DOC" were encoded using the very latest
  764. methods, you could type:
  765. X
  766. X    ARC c junk *.doc
  767. X
  768. Or if you wanted to convert every file in the archive,
  769. you could type:
  770. X
  771. X    ARC c junk
  772. X
  773. X
  774. X
  775. X
  776. X
  777. X
  778. X
  779. X
  780. X
  781. X
  782. X
  783. X
  784. X
  785. X
  786. X
  787. X
  788. X
  789. X
  790. X
  791. X
  792. X
  793. X
  794. X
  795. ARC                                             Page 12
  796. X           ARC OPTIONS
  797. X
  798. X
  799. X
  800. This section describes the options which are available
  801. to modify how ARC works.  Any of these options can be
  802. combined with any of the commands, though the result
  803. may not always be something you'd want to do.
  804. X
  805. X
  806. X
  807. SUPPRESSING COMPRESSION
  808. X
  809. The "S" (Suppress compression) option can be combined
  810. with any command that updates archive entries.  These
  811. include Add, Move, Update, Freshen, and Convert.  The
  812. effect of the S option is to prevent any compression
  813. techniques from being employed.  This is intended to
  814. allow you to add a few files at a time to an archive
  815. quickly, and then later convert the archive to
  816. compress everything at once.
  817. X
  818. XFor example, over the course of a day you might give
  819. each of the following commands:
  820. X
  821. X    ARC as junk *.txt
  822. X    ARC as junk *.mac
  823. X    ARC as junk *.doc
  824. X
  825. At the end of the day, when you have finished adding
  826. things to the archive, you could have all of the
  827. archive entries compressed at once by typing:
  828. X
  829. X    ARC c junk
  830. X
  831. You could also decompress the archive by typing:
  832. X
  833. X    ARC cs junk
  834. X
  835. though I can't imagine why you'd want to.
  836. X
  837. X
  838. X
  839. X
  840. X
  841. X
  842. X
  843. X
  844. X
  845. X
  846. X
  847. X
  848. X
  849. X
  850. ARC                                             Page 13
  851. X BACKUP RETENTION
  852. X
  853. When ARC changes an archive (during an Add, Move,
  854. Update, Freshen, Delete, or Convert) it creates a new
  855. archive with the same name, but with an extension of
  856. X".$$$".  For example, if you add a file to an archive
  857. named STUFF.ARC, then ARC will create a new archive
  858. named STUFF.$$$.  ARC will read from your existing
  859. archive and write out the new archive with any changes
  860. to the ".$$$" copy.
  861. X
  862. Normally when ARC is finished it deletes the original
  863. and renames the new archive to the original name (ie.
  864. STUFF.ARC goes away, and STUFF.$$$ becomes the new
  865. STUFF.ARC).  Among other things, this means that if
  866. anything goes wrong and ARC is unable to finish, then
  867. your original archive will still be intact.
  868. X
  869. X
  870. In some circumstances you may wish to retain the
  871. original version of the archive as a backup copy.  You
  872. can do this easily by using the Backup option.  Add
  873. the letter "B" to your command, and ARC will rename
  874. your original archive to have an extension of ".BAK"
  875. instead of deleting it.
  876. X
  877. X
  878. In other words, if you wanted to add "WASTE.TXT" to an
  879. archive named "JUNK.ARC", but wanted to keep a backup
  880. copy, then you would type:
  881. X
  882. X    ARC ab junk waste.txt
  883. X
  884. Your original archive would become "JUNK.BAK", while
  885. X"JUNK.ARC" would contain the new "WASTE.TXT" file.
  886. X
  887. X
  888. If you keep a backup of an archive which already has a
  889. backup, then the older backup copy is deleted.
  890. X
  891. X
  892. X
  893. X
  894. X
  895. X
  896. X
  897. X
  898. X
  899. X
  900. X
  901. X
  902. X
  903. X
  904. X
  905. ARC                                             Page 14
  906. X MESSAGE SUPPRESSION
  907. X
  908. ARC prints three types of messages: warnings,
  909. comments, and errors.
  910. X
  911. Warnings are messages about suspected error
  912. conditions, such as when a file to be extracted
  913. already exists, or when an extracted file fails the
  914. CRC error check.  Warnings may be suppressed by use of
  915. the "W" (Warn) command.  You should use this command
  916. sparingly.  In fact, you should probably not use this
  917. command at all.
  918. X
  919. Comments (or notes) are informative messages, such as
  920. naming each file as it is added to the archive.
  921. Comments and notes may be suppressed by use of the "N"
  922. X(Note) command.
  923. X
  924. XErrors are actual system problems, such as running out
  925. of disk space.  You cannot suppress errors.
  926. X
  927. X
  928. XFor example, suppose you extracted all files with an
  929. extension of ".BAS" from an archive named "JUNK.ARC"
  930. Then, after making some changes which you decide not
  931. to keep, you decide that you want to extract them all
  932. again, but you don't want to be asked to confirm every
  933. one.  In this case, you could type:
  934. X
  935. X    ARC xw junk *.bas
  936. X
  937. Or, if you are going to add a hundred files with an
  938. extension of ".MSG" to an archive named "TRASH.ARC",
  939. and you don't want ARC to list them as it adds them,
  940. you could type:
  941. X
  942. X    ARC an trash *.msg
  943. X
  944. Or, if you want to extract the entire contents of an
  945. archive named "JUNK.ARC", and you don't want to hear
  946. anything, then type:
  947. X
  948. X    ARC xnw junk
  949. X
  950. X
  951. A special case is provided when extracting files from
  952. an archive.  One of the various warnings that can
  953. occur is when a file being extracted already exists on
  954. disk.  Normally, ARC will stop and ask you if you want
  955. to overwrite the file.  This can be suppressed with
  956. the "W" command, but that will also suppress any
  957. X
  958. X
  959. X
  960. ARC                                             Page 15
  961. X warnings about other things, like failed CRC checks
  962. and such.
  963. X
  964. The "O" (Overwrite) option suppresses *only* the warning
  965. that the file already exists.  For example, in our
  966. earlier case of extracting all the ".BAS" files from
  967. X"JUNK.ARC", a much safer way to do it is to type:
  968. X
  969. X    ARC xo junk *.BAS
  970. X
  971. X
  972. X
  973. X
  974. X
  975. X
  976. X
  977. X
  978. X
  979. X
  980. X
  981. X
  982. X
  983. X
  984. X
  985. X
  986. X
  987. X
  988. X
  989. X
  990. X
  991. X
  992. X
  993. X
  994. X
  995. X
  996. X
  997. X
  998. X
  999. X
  1000. X
  1001. X
  1002. X
  1003. X
  1004. X
  1005. X
  1006. X
  1007. X
  1008. X
  1009. X
  1010. X
  1011. X
  1012. X
  1013. X
  1014. X
  1015. ARC                                             Page 16
  1016. X ENCRYPTION/DECRYPTION
  1017. X
  1018. Archive entries may be encrypted and decrypted by
  1019. using the "G" (Garble) option.  The Garble option
  1020. takes the remainder of the command string as the
  1021. password to use, so it must be the *last* option.
  1022. X
  1023. X
  1024. XFor example, if you wanted to add a file named
  1025. X"WASTE.TXT" to an archive named "JUNK.ARC", and you
  1026. wanted to encrypt it using the password "DEBRIS", then
  1027. you would type:
  1028. X
  1029. X    ARC agdebris junk waste.txt
  1030. X
  1031. Later on, when you want to extract it again, you would
  1032. type:
  1033. X
  1034. X    ARC xgdebris junk waste.txt
  1035. X
  1036. The password you supply is used to encrypt (or
  1037. decrypt) the archive entry by performing an exclusive
  1038. OR between each byte of the packed data and each byte
  1039. of the password.  The password can be any length, and
  1040. each of its bytes is used in rotation.  The password
  1041. is converted to uppercase before it is used, so it is
  1042. X*not* case sensitive.  Since the encryption is performed
  1043. on the packed data, it has no effect on stowage
  1044. factors.
  1045. X
  1046. This is not a particularly sophisticated means of
  1047. encryption, and it is theoretically possible to crack.
  1048. Still, since it is performed on the packed data, the
  1049. result should be quite sufficient for casual use.
  1050. X
  1051. X
  1052. You can, if you wish, use different passwords for
  1053. different files in an archive, but we advise against
  1054. it.  If you are going to encrypt an archive, we
  1055. suggest you use the same password for every file, and
  1056. give the password whenever you do anything at all with
  1057. the archive.  It is possible to list the entries in an
  1058. encrypted archive using the "L" and "V" commands
  1059. without giving the password, but nothing else will
  1060. work properly.
  1061. X
  1062. X
  1063. We advise that you use this option sparingly, if at
  1064. all.  If you should forget or mistype your password,
  1065. it is highly unlikely that you will ever recover your
  1066. data.
  1067. X
  1068. X
  1069. X
  1070. ARC                                             Page 17
  1071. X         RAMDISK SUPPORT
  1072. X
  1073. X
  1074. X
  1075. If you have a RAMdisk, or other high-speed storage,
  1076. then you can speed up ARC somewhat by telling it to
  1077. put its temporary files on the RAMdisk.  You do this
  1078. by setting the ARCTEMP environment string with the MS-
  1079. DOS SET command.  For example, if drive B: is your
  1080. RAMdisk, then you would type:
  1081. X
  1082. X    set ARCTEMP=B:
  1083. X
  1084. Refer to the MS-DOS manual for more details about the
  1085. SET command.  You need only set the ARCTEMP string
  1086. once, and ARC will use it from then on until you
  1087. change its value or reboot your system.
  1088. X
  1089. X
  1090. If ARC does not find an environment string named
  1091. ARCTEMP, then it looks for one named TEMP to use
  1092. instead.  Several packages already use the TEMP string
  1093. for exactly this purpose.  If you have need of an
  1094. environment string named TEMP for something else, then
  1095. you should be sure to define ARCTEMP.
  1096. X
  1097. X
  1098. There are a limited number of temporary files created
  1099. by ARC.  The Convert command uses a file named
  1100. X"$ARCTEMP.CVT" to hold each file as it is being
  1101. converted.  The Run command also creates a temporary
  1102. file, which has the name "$ARCTEMP", and whose
  1103. extension matches that of the file being run.
  1104. X
  1105. X
  1106. X
  1107. X
  1108. X
  1109. X
  1110. X
  1111. X
  1112. X
  1113. X
  1114. X
  1115. X
  1116. X
  1117. X
  1118. X
  1119. X
  1120. X
  1121. X
  1122. X
  1123. X
  1124. X
  1125. ARC                                             Page 18
  1126. X              MARC
  1127. X
  1128. X
  1129. X
  1130. MARC is a separate program which is used to merge
  1131. archives created by ARC.  MARC moves files from one
  1132. archive to another without unpacking them.
  1133. X
  1134. X
  1135. MARC is used as follows:
  1136. X
  1137. X    MARC <target> <source> [<template> . . .]
  1138. X
  1139. Where:
  1140. X
  1141. X    <target> is the name of the archive to add files
  1142. X    to.
  1143. X
  1144. X    <source> is the name of the archive to read files
  1145. X    from.
  1146. X
  1147. X    <template> is one or more file name templates.
  1148. X    The wildcard characters "*" and "?" may be used.
  1149. X    If no template is supplied, then all of the files
  1150. X    in <source> are added to <target>.
  1151. X
  1152. It is not necessary for the target to exist.  If it
  1153. does not exist, then it is created.  Thus, MARC can be
  1154. used as an "extractor" as well as a "merger".
  1155. X
  1156. X
  1157. XFor example, if you wanted to create an archive named
  1158. X"JUNK.ARC", which is to contain all of the files with
  1159. an extension of ".TXT" which are currently contained
  1160. in another archive named "WASTE.ARC", then you could
  1161. type:
  1162. X
  1163. X    MARC junk waste *.txt
  1164. X
  1165. If you wanted to create an archive named "JUNK.ARC",
  1166. which is to contain all of the files currently in the
  1167. archives "WASTE.ARC" and "TRASH.ARC", you could type:
  1168. X
  1169. X    MARC junk waste
  1170. X    MARC junk trash
  1171. X
  1172. X
  1173. If MARC is invoked with no arguments, then it gives
  1174. brief directions in its use.
  1175. X
  1176. X
  1177. X
  1178. X
  1179. X
  1180. ARC                                             Page 19
  1181. X              ARCE
  1182. X
  1183. X
  1184. X
  1185. ARCE is a program which is used to extract files from
  1186. an archive.  It will *only* extract files, and it will
  1187. X*not* extract encrypted files.  It doesn't do anything
  1188. that ARC can't do, but it is highly optimized for the
  1189. sole purpose of archive extraction, so it is very
  1190. small and very fast.
  1191. X
  1192. ARCE is used in a fashion very similar to the "ARC E"
  1193. command (hence the name).  The first argument is the
  1194. name of the archive to extract files from, and may
  1195. include a drive and path specifier.  Up to sixteen
  1196. additional arguments can be supplied, which specify
  1197. the files to extract.  The wildcard characters "*" and
  1198. X"?" are allowed, as with ARC.  If no files are named,
  1199. then all files are extracted from the archive.  If the
  1200. file being extracted already exists, you are asked
  1201. whether or not you want to overwrite it.  You can use
  1202. the "/R" option to bypass this.
  1203. X
  1204. XFor example, if you had an archive named "WASTE.ARC"
  1205. that you wanted to extract everything from, then you
  1206. could type:
  1207. X
  1208. X    ARCE waste
  1209. X
  1210. Or if you just wanted to extract the files with a
  1211. filename extension of ".ASM", you could type:
  1212. X
  1213. X    ARCE waste *.asm
  1214. X
  1215. If you already have a few files from the archive that
  1216. you want replaced, then you could type:
  1217. X
  1218. X    ARCE waste *.asm /R
  1219. X
  1220. If you run ARCE with no arguments at all, then it will
  1221. give you a brief reminder of how to use it.
  1222. X
  1223. X
  1224. NOTICE: ARCE is the copyrighted property of Vernon D.
  1225. X        Buerg and Wayne Chin.  It is included on the
  1226. X        ARC program disk as a service to ARC users.
  1227. X
  1228. X        Vernon D. Buerg
  1229. X        456 Lakeshire Drive
  1230. X        Daly City, CA  94015
  1231. X        RBBS: (415) 994-2944
  1232. X
  1233. X
  1234. X
  1235. ARC                                             Page 20
  1236. X         VERSION NUMBERS
  1237. X
  1238. X
  1239. X
  1240. There seems to be some confusion about our version
  1241. numbering scheme.  All of our version numbers are
  1242. given as a number with two decimal places.
  1243. X
  1244. The units indicate a major revision, such as adding a
  1245. new packing algorithm.
  1246. X
  1247. The first decimal place (tenths) indicates a minor
  1248. revision that is not essential, but which may be
  1249. desired.
  1250. X
  1251. The second decimal place (hundredths) indicates a
  1252. trivial revision that will probably only be desired by
  1253. specific individuals or by die-hard "latest version"
  1254. fanatics.
  1255. X
  1256. ARC also displays its date and time of last edit.  A
  1257. change of the date and time without a corresponding
  1258. change in version number indicates a truly trivial
  1259. change, such as fixing a spelling error.
  1260. X
  1261. X
  1262. To sum up: If the units change, then you should get
  1263. the newer version as soon as you can.  If the tenths
  1264. change, then you may want to get the newer version,
  1265. but there's no hurry.  If anything else changes, then
  1266. you probably shouldn't bother.
  1267. X
  1268. X
  1269. X
  1270. X
  1271. X
  1272. X
  1273. X
  1274. X
  1275. X
  1276. X
  1277. X
  1278. X
  1279. X
  1280. X
  1281. X
  1282. X
  1283. X
  1284. X
  1285. X
  1286. X
  1287. X
  1288. X
  1289. X
  1290. ARC                                             Page 21
  1291. X  COMMON QUESTIONS AND ANSWERS
  1292. X
  1293. X
  1294. X
  1295. Here are some of the more common questions we've
  1296. received about ARC, along with their answers:
  1297. X
  1298. X
  1299. Q: Why does ARC run out of room if I make an archive
  1300. X   bigger than about 180k?
  1301. X
  1302. A: Because you are working on a floppy disk.  ARC
  1303. X   creates a copy of your archive, incorporating any
  1304. X   new files as it goes.  When it is done, it deletes
  1305. X   the original and renames the new one.  There are a
  1306. X   number of reasons for doing it this way, one being
  1307. X   that your original archive is still intact if
  1308. X   anything happens while ARC is running.
  1309. X
  1310. X   You can save some space by using drive specifiers
  1311. X   and having the archive and the files to add on
  1312. X   separate disks, but you still won't be able to make
  1313. X   an archive larger than about 180k.  If you need to
  1314. X   make a larger archive, and if you have a fixed
  1315. X   disk, then you can create the archive on the fixed
  1316. X   disk and then copy it to the floppy.
  1317. X
  1318. X
  1319. Q: I've seen an ARC.COM and an ARC.EXE.  Which one is
  1320. X   the right one?
  1321. X
  1322. A: ARC.EXE.  One or more people have been running ARC
  1323. X   through a utility that converts an ".EXE" file to a
  1324. X   ".COM" file.  But this utility is designed to save
  1325. X   space, not speed.  On ARC it saves about 250 bytes,
  1326. X   and makes no measurable difference in program
  1327. X   speed.  We've decided that the savings are not
  1328. X   worth the extra step in development in this case.
  1329. X
  1330. X
  1331. Q: How can I get the latest version of ARC?
  1332. X
  1333. A: ARC updates are distributed through normal
  1334. X   shareware channels, and by FidoNet.  We also ship a
  1335. X   program update disk on every order of $50 or more.
  1336. X   Also, please refer to the next section for
  1337. X   information about our maintenance contracts.
  1338. X
  1339. X
  1340. X
  1341. X
  1342. X
  1343. X
  1344. X
  1345. ARC                                             Page 22
  1346. X Q: Can I use ARC to distribute my public domain or
  1347. X   shareware program?
  1348. X
  1349. A: Yes, of course.
  1350. X
  1351. X
  1352. Q: Can I use ARC to distribute my commercial software
  1353. X   package?
  1354. X
  1355. A: Yes, provided that you obtain a commercial
  1356. X   distribution license from us.  Please contact us
  1357. X   for details.
  1358. X
  1359. X
  1360. Q: I'm a commercial user.  Why should I pay for
  1361. X   shareware that others get for free?
  1362. X
  1363. A: Because you cannot credibly plead poverty.
  1364. X   Shareware, all shareware, is an attempt to develop
  1365. X   a new marketing channel to the benefit of everyone.
  1366. X   You can still "test drive" shareware for a short
  1367. X   period, but if you decide to use it in your
  1368. X   business, then you should pay for it.
  1369. X
  1370. X
  1371. Q: Why not allow me to select which method of
  1372. X   compression I want ARC to use?
  1373. X
  1374. A: It would needlessly complicate ARC, both internally
  1375. X   and in use.  The exact nature of the compression
  1376. X   methods used are complex, and quite different.  The
  1377. X   only sure way to tell which will be best in any
  1378. X   given case is to analyze the data, as ARC does.
  1379. X   The method chosen may not always be what you
  1380. X   expect.
  1381. X
  1382. X
  1383. X
  1384. X
  1385. X
  1386. X
  1387. X
  1388. X
  1389. X
  1390. X
  1391. X
  1392. X
  1393. X
  1394. X
  1395. X
  1396. X
  1397. X
  1398. X
  1399. X
  1400. ARC                                             Page 23
  1401. X      MAINTENANCE CONTRACTS
  1402. X
  1403. X
  1404. X
  1405. Registered users of ARC receive 90 days of telephone
  1406. support at no extra charge.  If you wish, you can
  1407. extend this by pruchasing a maintenance contract.
  1408. X
  1409. A maintenance contract costs $50 per year and entitles
  1410. you to unlimited telephone support, as well as free
  1411. updates to ARC as they come out.
  1412. X
  1413. X
  1414. X
  1415. X
  1416. X
  1417. X
  1418. X
  1419. X
  1420. X
  1421. X
  1422. X
  1423. X
  1424. X
  1425. X
  1426. X
  1427. X
  1428. X
  1429. X
  1430. X
  1431. X
  1432. X
  1433. X
  1434. X
  1435. X
  1436. X
  1437. X
  1438. X
  1439. X
  1440. X
  1441. X
  1442. X
  1443. X
  1444. X
  1445. X
  1446. X
  1447. X
  1448. X
  1449. X
  1450. X
  1451. X
  1452. X
  1453. X
  1454. X
  1455. ARC                                             Page 24
  1456. X        REVISION HISTORY
  1457. X
  1458. X
  1459. X
  1460. CHANGES IN VERSION 3
  1461. X
  1462. The function used to calculate the CRC check value in
  1463. previous versions has been found to be in error.  It
  1464. has been replaced with the proper function.  ARC will
  1465. still read archives created with earlier versions of
  1466. ARC, but it will report a warning that the CRC value
  1467. is in error.  All archives created prior to version
  1468. X3.0 should be unpacked and repacked with the latest
  1469. version of ARC.
  1470. X
  1471. X
  1472. Transmitting a file with XMODEM protocol rounds the
  1473. size up to the next multiple of 128 bytes, adding
  1474. garbage to the end of the file.  This used to confuse
  1475. ARC, causing it to think that the end of the archive
  1476. was invalidly formatted.  This has been corrected in
  1477. version 3.01.  Older archives may still be read, but
  1478. ARC may report them to be improperly formatted.  All
  1479. files can be extracted, and no data is lost.  In
  1480. addition, ARC will automatically correct the problem
  1481. when it is encountered.
  1482. X
  1483. X
  1484. X
  1485. CHANGES IN VERSION 4
  1486. X
  1487. ARC is adding another data compression technique in
  1488. this version.  We have been looking for some technique
  1489. that could improve on Huffman squeezing in at least a
  1490. few cases.  So far, Lempel-Zev compression seems to be
  1491. fulfilling our fondest hopes, often achieving
  1492. compression rates as much as 20% better than
  1493. squeezing, and sometimes even better.  Huffman
  1494. squeezing depends on some bytes being more "popular"
  1495. than others, taking the file as a whole.  Lempel-Zev
  1496. compression is instead looking for strings of bytes
  1497. which are repeated at various points (such as an end
  1498. of line followed by spaces for indentation).  Lempel-
  1499. Zev compression is therefore looking for repetition at
  1500. a more "macro" level, often achieving impressive
  1501. packing rates.
  1502. X
  1503. In the typical case a file is added to an archive once
  1504. and then extracted many times, so the increased time
  1505. for an update should more than pay for itself in
  1506. increased disk space and reduced transmission time.
  1507. X
  1508. X
  1509. X
  1510. ARC                                             Page 25
  1511. X CHANGES IN VERSION 4.1
  1512. X
  1513. Lempel-Zev coding has been improved somewhat by
  1514. performing non-repeat compression on the data before
  1515. it is coded (as was already done with Huffman
  1516. squeezing).  This has the two fold advantage of (a)
  1517. reducing to some extent the amount of data to be
  1518. encoded, and (b) increasing the time it takes for the
  1519. string table to fill up.  Performance gains are small,
  1520. but noticeable.
  1521. X
  1522. The primary changes are in internal organization.  ARC
  1523. is now much "cleaner" inside.  In addition to the
  1524. aesthetic benefits to the author, this should make
  1525. life easier for the hackers out there.  There is also
  1526. a slight, but not noticeable, improvement in overall
  1527. speed when doing an update.
  1528. X
  1529. X
  1530. X
  1531. CHANGES IN VERSION 4.3
  1532. X
  1533. Version 4.3 adds the much-demanded feature of using
  1534. pathnames when adding files to an archive.
  1535. X
  1536. Version 4.3 is also using a slightly different
  1537. approach when adding a file to an archive.  The end
  1538. result is twofold:
  1539. X
  1540. X1) Slightly more disk space is required on the drive
  1541. X   containing the archive.  This should only be
  1542. X   noticeable to those creating very large archives on
  1543. X   a floppy based system.
  1544. X
  1545. X2) A 30% reduction in packing time has been achieved
  1546. X   in most cases.  This should be noticeable to
  1547. X   everyone.
  1548. X
  1549. As always, version 4.3 is still fully upwards
  1550. compatible, and is backwards compatible as far as
  1551. version 4.1.
  1552. X
  1553. X
  1554. X
  1555. X
  1556. X
  1557. X
  1558. X
  1559. X
  1560. X
  1561. X
  1562. X
  1563. X
  1564. X
  1565. ARC                                             Page 26
  1566. X CHANGES IN VERSION 4.4
  1567. X
  1568. The temporary file introduced in version 4.3
  1569. occasionally caused problems for people who had not
  1570. added a FILES= statement to their CONFIG.SYS file.
  1571. This has now been corrected.  Also, support of the
  1572. ARCTEMP environment string was added to allow placing
  1573. of the temporary file on a RAMdisk.
  1574. X
  1575. A bug was reported in the Run command, which has been
  1576. fixed.  From the nature of the bug, and the extreme
  1577. time required before the bug was reported, it is
  1578. deduced that the Run command is probably the least
  1579. used feature of ARC.
  1580. X
  1581. The Update command was changed.  It is no longer a
  1582. straight synonym for Add.  Instead, Update now only
  1583. adds a file if it is newer than the version already in
  1584. the archive, as shown by the MS-DOS date/time stamp.
  1585. X
  1586. X
  1587. X
  1588. CHANGES IN VERSION 4.5
  1589. X
  1590. The Convert command was not making use of RAMdisk
  1591. support.  Now it is.
  1592. X
  1593. The Freshen command was added.  Our first choice for a
  1594. name was Refresh, but we already had a Run command.
  1595. Assuming that you have an archive which already
  1596. contains everything you want in it (for software
  1597. distribution, perhaps), then Freshen would be used to
  1598. update the archive.  It was pointed out to us that ARC
  1599. already knows what is in the archive, so it should be
  1600. able to look on disk for newer versions.  Now it can.
  1601. X
  1602. The Suppress compression option was added by popular
  1603. demand.  It allows files to be added quickly to an
  1604. archive, since the files are not analyzed or
  1605. compressed, but merely stored straight.  The intent is
  1606. to allow users to build an archive "in pieces", and
  1607. then compress all of the entries at once with the
  1608. Convert command.  The conversion is much faster if you
  1609. take advantage of RAMdisk support.
  1610. X
  1611. A minor bug was detected in our handling of date/time
  1612. stamps which occasionally resulted in stamping an
  1613. archive with the wrong date and time.  This has been
  1614. corrected.
  1615. X
  1616. X
  1617. X
  1618. X
  1619. X
  1620. ARC                                             Page 27
  1621. X CHANGES IN VERSION 5.0
  1622. X
  1623. The Move command used to delete the files as it went.
  1624. It now waits until it is finished updating the
  1625. archive, and deletes them all at once.  (You *did* know
  1626. that Move is just an Add where the file gets deleted,
  1627. didn't you?)  This, along with the changes made in
  1628. version 4.5, means that it is now much safer to
  1629. interrupt ARC while it is working.
  1630. X
  1631. The Print command no longer prints the name of each
  1632. file.  Instead, it prints a formfeed after each file.
  1633. X
  1634. The Run command now supports BASICA programs.  Also,
  1635. the filename extension is no longer required on the
  1636. Run command.
  1637. X
  1638. The Garble option was added.  It provides a convenient
  1639. means of low level data security for the casual user.
  1640. Use it sparingly, if at all.
  1641. X
  1642. ARC no longer tests for the presence of $ARCTEMP.CRN
  1643. before creating a new one.  If you interrupt ARC a
  1644. lot, you'll find this much more convenient.  If you
  1645. happen to have a file named $ARCTEMP.CRN which you
  1646. want to keep, too bad.
  1647. X
  1648. Improved error recovery was added when reading an
  1649. archive.  ARC now has a good chance of recovering the
  1650. data from a corrupted archive (the corrupted entry is
  1651. still lost, of course).
  1652. X
  1653. Path support has been added for all commands, though
  1654. it doesn't do anything on most of them.  For example,
  1655. there isn't much we can do with a path in the List
  1656. command.  But many users will be glad to know that a
  1657. path can be used when extracting a file, and specifies
  1658. where the file is to be placed.
  1659. X
  1660. Support for the TEMP environment string was added.  If
  1661. ARC doesn't find an environment string named ARCTEMP,
  1662. then it looks for one named TEMP to use instead.
  1663. Several packages already use the TEMP string for
  1664. exactly this purpose.  With any luck, maybe we can get
  1665. a standard going.
  1666. X
  1667. X
  1668. X
  1669. X
  1670. X
  1671. X
  1672. X
  1673. X
  1674. X
  1675. ARC                                             Page 28
  1676. X ARC is now using a different variation of Lempel-Zev
  1677. coding, courtesy of Kent Williams, who found it on
  1678. USENET and adapted it to the IBM PC.  The new method
  1679. differs from the old in several respects.  The most
  1680. significant differences are:
  1681. X
  1682. X1) Where our previous implementation used a fixed code
  1683. X   size of twelve bits, the new one starts with a code
  1684. X   size of nine bits and increases it as it needs to.
  1685. X
  1686. X2) The earlier method tended to "choke" on large files
  1687. X   when its string table filled up.  The new method
  1688. X   has a rather ingenious scheme its authors call
  1689. X   "adaptive reset."  When it notices that its string
  1690. X   table has filled, and its compression ratio is
  1691. X   starting to suffer, it clears the table and starts
  1692. X   defining new strings.
  1693. X
  1694. Our benchmarks show an improvement in compression on
  1695. the order of 10% when crunching is used.
  1696. Additionally, ARC 5.0 is on the order of 23% faster at
  1697. adding a file when crunching is used, or 13% faster
  1698. when squeezing is used.  Extracting a file crunched
  1699. with the new method is 27% faster than it is with the
  1700. old method.  Extraction of any other type of file
  1701. X(including those crunched with the older method) is no
  1702. faster than before.  These figures are based on our
  1703. own benchmark tests; your results may vary.
  1704. X
  1705. The previous implementation of Lempel-Zev coding is no
  1706. longer used to pack files.  The "V" (Verbose listing)
  1707. command distinguishes between the two by referring to
  1708. the older method as "crunched" (with a lower-case
  1709. X"c"), and the newer method as "Crunched" (with a
  1710. capital "C").
  1711. X
  1712. ARC 5.0 can still read archives created by earlier
  1713. versions of ARC, but once again it creates archives
  1714. which older versions cannot read.
  1715. X
  1716. X
  1717. X
  1718. CHANGES IN VERSION 5.1
  1719. X
  1720. Rick Moore discovered that ARC was occasionally adding
  1721. an archive to itself.  This would only happen when the
  1722. archive is in the same directory as the files being
  1723. added, and its name comes last.  This bug has been
  1724. fixed, though it is still possible to fool ARC into
  1725. adding an archive to itself by getting tricky with
  1726. path names.
  1727. X
  1728. X
  1729. X
  1730. ARC                                             Page 29
  1731. X Dana Montgomery found the upper limit on how many
  1732. files can be added to an archive.  There's always been
  1733. an upper limit, but it depends on memory, and used to
  1734. be larger than anyone could possibly want (knock on
  1735. wood).  However, the added memory requirements in
  1736. version 5.0 lowered this limit into the realm of
  1737. possibility, somewhere around 300 files.  We change
  1738. some things around, and effectively, there is no
  1739. longer a limit on how many files you can add at once.
  1740. ARC will add the files in batches of as many as it can
  1741. handle at one time.
  1742. X
  1743. We've also introduced a new packaging method for ARC
  1744. and its documentation, since we are in the unique
  1745. position of being unable to use ARC for this purpose.
  1746. We've created a program called ARC51.COM which, when
  1747. executed, attempts to create the ARC program and
  1748. manual.  You must be in the same directory as
  1749. ARC51.COM when you run it.
  1750. X
  1751. X
  1752. X
  1753. CHANGES IN VERSION 5.2
  1754. X
  1755. We've made some changes to Lempel-Zev coding to
  1756. further improve its compression ability on "poor fit"
  1757. files (mainly .EXE and .COM files).  The result is
  1758. that crunching now works better than squeezing on
  1759. almost all files, and comes close on most of the rest
  1760. X(within 5%, by our benchmarks).  Accordingly, we have
  1761. dropped Huffman encoding in this version.  Our
  1762. benchmarks show a speed improvement of around 14% when
  1763. adding a file to an archive.
  1764. X
  1765. A low-level file copy routine was implemented to speed
  1766. up bulk data moves.  Deleting or adding a file to a
  1767. large existing archive is now much faster.
  1768. X
  1769. The Run command has been modified to allow passing
  1770. command line arguments to the program being run.
  1771. X
  1772. The temporary file introduced in version 4.3 has been
  1773. eliminated.  Crunched output generated in the analysis
  1774. phase is now placed directly in the output archive,
  1775. and is rewritten if crunching turns out not to be the
  1776. best choice.  This can, in rare circumstances, cause
  1777. an archive to be slightly larger than it should be,
  1778. but it also makes ARC considerably faster at adding
  1779. files to an archive.
  1780. X
  1781. X
  1782. X
  1783. X
  1784. X
  1785. ARC                                             Page 30
  1786. X   PROGRAM HISTORY AND CREDITS
  1787. X
  1788. X
  1789. X
  1790. In its short life thus far, ARC has astounded us with
  1791. its popularity.  We first wrote it in March of 1985
  1792. because we wanted an archive utility that used a
  1793. distributive directory approach, since this has
  1794. certain advantages over the then popular central
  1795. directory approach.  We added automatic squeezing in
  1796. version 2 at the prompting of a friend.  In version
  1797. X2.1 we added the code to test for the best compression
  1798. method.  In less than a year we found that our humble
  1799. little program had spread across the country, and
  1800. seems to have become a new institution.
  1801. X
  1802. We are thankful for the support and appreciation we
  1803. have received.  We hope that you find this program of
  1804. use.
  1805. X
  1806. X
  1807. If we have achieved greatness, it is because we have
  1808. stood upon the shoulders of giants.  Nothing is
  1809. created as a thing unto itself, and ARC is no
  1810. exception.  Therefore, we would like to give credit to
  1811. the following people, without whose efforts ARC could
  1812. not exist:
  1813. X
  1814. X
  1815. Brian W. Kernighan and P. J. Plauger, whose book
  1816. X"Software Tools" provided many of the ideas behind the
  1817. distributive directory approach used by ARC.
  1818. X
  1819. Dick Greenlaw, who wrote the public domain SQ and USQ
  1820. programs, in which the Huffman squeezing algorithm was
  1821. first developed.
  1822. X
  1823. Robert J. Beilstein, who adapted SQ and USQ to
  1824. Computer Innovations C86 (the language we use), thus
  1825. providing us with important parts of our squeezing
  1826. logic.
  1827. X
  1828. Kent Williams, who graciously allowed us to use his
  1829. LZWCOM and LZWUNC programs as a basis for our Lempel-
  1830. Zev compression logic, and who continues to make
  1831. valuable contributions.
  1832. X
  1833. David Schwaderer, whose article in the April 1985
  1834. issue of PC Tech Journal provided us with the logic
  1835. for calculating the CRC 16 bit polynomial.
  1836. X
  1837. X
  1838. X
  1839. X
  1840. ARC                                             Page 31
  1841. X Terry A. Welch, whose article "A Technique for High
  1842. Performance Data Compression", IEEE Computer Vol 17 No
  1843. X6 (June 1984) seems to have started all the research
  1844. on Lempel-Zev coding.
  1845. X
  1846. Spencer W. Thomas, Jim McKie, Steve Davies, Ken
  1847. Turkowski, James A.  Woods, and Joe Orost, who are the
  1848. authors of the UNIX compress utility.
  1849. X
  1850. Alex Jacobs, who in June of 1985 sent us the very
  1851. first shareware contribution we ever received.
  1852. X
  1853. X
  1854. And many, many others whom we could not identify.
  1855. X
  1856. X
  1857. X
  1858. X
  1859. X
  1860. X
  1861. X
  1862. X
  1863. X
  1864. X
  1865. X
  1866. X
  1867. X
  1868. X
  1869. X
  1870. X
  1871. X
  1872. X
  1873. X
  1874. X
  1875. X
  1876. X
  1877. X
  1878. X
  1879. X
  1880. X
  1881. X
  1882. X
  1883. X
  1884. X
  1885. X
  1886. X
  1887. X
  1888. X
  1889. X
  1890. X
  1891. X
  1892. X
  1893. X
  1894. X
  1895. ARC                                             Page 32
  1896. X         BULLETIN BOARDS
  1897. X
  1898. X
  1899. X
  1900. ARC is distributed mainly through shareware channels.
  1901. Among other things, this means that ARC is available
  1902. from many bulletin board systems.  In fact, the system
  1903. operators (sysops) of many bulletin boards have taken
  1904. to storing almost all of their downloadable files in
  1905. archives to save themselves disk space and to save
  1906. their users time.
  1907. X
  1908. This also makes things more convenient for the
  1909. bulletin board users, since one archive may contain
  1910. several programs, any related data files, and the
  1911. documentation.  Many shareware authors have taken to
  1912. distributing their software in archives to help ensure
  1913. that the users receive everything.
  1914. X
  1915. Obviously, we can't do that with ARC.  As a result,
  1916. many of our users have ARC, but don't have the manual.
  1917. Most of our customer support calls come from people
  1918. who have never seen the manual, and in many cases
  1919. didn't even know that one exists!
  1920. X
  1921. To solve this problem we developed what is in essence
  1922. a self-unpacking archive.  We distribute this as
  1923. X"ARCxxx.COM", where "xxx" is the current version
  1924. number.  For example, ARC version 5.20 would be
  1925. distributed as "ARC520.COM".  This program, when run,
  1926. unpacks itself into a copy of ARC plus its
  1927. documentation.
  1928. X
  1929. Now that we've gone to all that work, we'd really
  1930. appreciate it if you would use this program when you
  1931. distribute ARC.
  1932. X
  1933. X
  1934. X
  1935. X
  1936. X
  1937. X
  1938. X
  1939. X
  1940. X
  1941. X
  1942. X
  1943. X
  1944. X
  1945. X
  1946. X
  1947. X
  1948. X
  1949. X
  1950. ARC                                             Page 33
  1951. X          SITE LICENSES
  1952. X
  1953. X
  1954. X
  1955. Corporate users may wish to obtain a site license for
  1956. the use of ARC.  Please use the order form in this
  1957. manual to order a site license.  Site licenses are
  1958. granted as of when we receive your payment.  License
  1959. fees vary depending on the number of computers on
  1960. which ARC will be used, as follows:
  1961. X
  1962. X     1 to  9 machines  $35 each
  1963. X    10 to 24 machines  $25 each
  1964. X    25 to 49 machines  $20 each
  1965. X    50 to 99 machines  $15 each
  1966. X    over  99 machines  $1500 one time fee
  1967. X
  1968. X
  1969. X
  1970. XEnclosed is a site license agreement, which should be
  1971. signed and sent with your payment when ordering a
  1972. commercial site license.
  1973. X
  1974. X
  1975. A commercial site license does not include additional
  1976. copies of the ARC program disk and the ARC manual.
  1977. Instead, you make your own copies of the disk and
  1978. manual as you need them.  If you wish, you can order
  1979. additional program disks and manuals from us.
  1980. X
  1981. Additional program disks cost $10 each.  Additional
  1982. manuals cost $20 each.  If you wish, you can order
  1983. program sets for $40 each.  A "program set" is a
  1984. program disk and manual enclosed in a vinyl binder.
  1985. There is a $50 minimum on all orders.
  1986. X
  1987. X
  1988. X
  1989. X
  1990. X
  1991. X
  1992. X
  1993. X
  1994. X
  1995. X
  1996. X
  1997. X
  1998. X
  1999. X
  2000. X
  2001. X
  2002. X
  2003. X
  2004. X
  2005. ARC                                             Page 34
  2006. X              SITE LICENSE APPLICATION
  2007. X
  2008. X
  2009. X
  2010. The use of ARC in a commercial environment or government organization
  2011. is granted under the following terms:
  2012. X
  2013. X1.  Payment of the license fee must be made to System Enhancement
  2014. X    Associates, Inc.  The fee is based on the number of computers
  2015. X    which will be used to run ARC, as follows:
  2016. X
  2017. X          1 to  9 machines  $35 each
  2018. X         10 to 24 machines  $25 each
  2019. X         25 to 49 machines  $20 each
  2020. X         50 to 99 machines  $15 each
  2021. X         over  99 machines  $1500 one time fee
  2022. X
  2023. X2.  You may use ARC on the number of computers included in the license
  2024. X    fee.  If you have paid the fee for over 99 machines, then you may
  2025. X    use ARC on any number of computers within your organization.
  2026. X
  2027. X3.  You may make copies of the program and documentation, in their
  2028. X    original,  unmodified form,  without restriction.  You may
  2029. X    distribute these copies without restriction.
  2030. X
  2031. X4.  If these copies are distributed outside of your organization,  you
  2032. X    have no obligation to control the use of those copies which are
  2033. X    outside of your organization.
  2034. X
  2035. X5.  You may make copies of the program documentation, in both its
  2036. X    printed form and machine readable form, without restriction.
  2037. X
  2038. X6.  You may use all future versions of ARC under this license.
  2039. X
  2040. X7.  You may *not* modify the program or charge a fee for copying or
  2041. X    distributing the program or its documentation.
  2042. X
  2043. X8.  It is your responsibility to make the necessary copies and to
  2044. X    deliver them to the computers which they will be used on.  If you
  2045. X    wish, you can order additional ARC program disks and manuals.
  2046. X
  2047. X9.  We are not responsible for *anything* that may happen or not happen
  2048. X    if you use ARC.  You're on your own.
  2049. X
  2050. X
  2051. X    I agree to abide by the terms and conditions of this license.
  2052. X
  2053. X    _____________________________         __________________________
  2054. X    Signature                             Date
  2055. X
  2056. X    _____________________________
  2057. X    Name (please print or type)
  2058. X
  2059. X    _____________________________
  2060. X    Title
  2061. X
  2062. X    _____________________________
  2063. X    Company
  2064. X
  2065. X
  2066. X                    ORDER FORM
  2067. X
  2068. X
  2069. X
  2070. Check which items you wish to purchase:
  2071. X
  2072. X    [] Noncommercial license for the use of ARC.
  2073. X
  2074. X    [] Commercial license for the use of ARC on ___ computers (see
  2075. X       attached price schedule and terms).
  2076. X
  2077. X    [] Program disk and documentation (only on orders of $50 or more,
  2078. X       not counting maintenance contracts).
  2079. X
  2080. X    [] ____ additional program disks at $10 per disk.
  2081. X
  2082. X    [] ____ additional manuals at $20 per manual
  2083. X
  2084. X    [] ____ additional program sets (disk, manual, and binder) at $40
  2085. X       per program set.
  2086. X
  2087. X    [] One year maintenance agreement at $50 per year.
  2088. X
  2089. X    [] Payment of $_____ is enclosed (check or money order).
  2090. X
  2091. X    [] Please charge $_____ to my [] Visa or [] MasterCard:
  2092. X
  2093. X      Card number:  _______________________________
  2094. X
  2095. X      Expiration date:  ___________________________
  2096. X
  2097. X      Signature:  _________________________________
  2098. X
  2099. X    _______________________________________________
  2100. X    Name
  2101. X
  2102. X    _______________________________________________
  2103. X
  2104. X
  2105. X    _______________________________________________
  2106. X    Address
  2107. X
  2108. X    ______________________   ________  ____________
  2109. X    City                     State     Zip
  2110. X
  2111. X    _______/_______
  2112. X    FidoNet address
  2113. X
  2114. X
  2115. Send this completed form to:
  2116. X
  2117. X                  System Enhancement Associates, Inc.
  2118. X                     21 New Street, Wayne NJ 07470
  2119. X
  2120. XFor program disk orders outside the U.S., please add an additional $5,
  2121. and enclose an international money order payable in U.S. currency.
  2122. X
  2123. XFor commercial site license orders, please enclose a signed copy of
  2124. the site license agreement.
  2125. X
  2126. END_OF_FILE
  2127. if test 54118 -ne `wc -c <'Arc521.doc'`; then
  2128.     echo shar: \"'Arc521.doc'\" unpacked with wrong size!
  2129. fi
  2130. # end of 'Arc521.doc'
  2131. fi
  2132. echo shar: End of archive 3 \(of 3\).
  2133. cp /dev/null ark3isdone
  2134. MISSING=""
  2135. for I in 1 2 3 ; do
  2136.     if test ! -f ark${I}isdone ; then
  2137.     MISSING="${MISSING} ${I}"
  2138.     fi
  2139. done
  2140. if test "${MISSING}" = "" ; then
  2141.     echo You have unpacked all 3 archives.
  2142.     rm -f ark[1-9]isdone
  2143. else
  2144.     echo You still need to unpack the following archives:
  2145.     echo "        " ${MISSING}
  2146. fi
  2147. ##  End of shell archive.
  2148. exit 0
  2149.